home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / share / man / cat3 / XmTextGetSubstringWcs.z / XmTextGetSubstringWcs
Encoding:
Text File  |  2003-11-18  |  4.6 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       _X_m_T_e_x_t_G_e_t_S_u_b_s_t_r_i_n_g_W_c_s    - A Text function that retrieves a
  10.       portion of a wide character internal text buffer
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.       #include <Xm/Text.h>
  14.  
  15.       int XmTextGetSubstringWcs (wwwwiiiiddddggggeeeetttt,,,, ssssttttaaaarrrrtttt,,,, nnnnuuuummmm____cccchhhhaaaarrrrssss,,,, bbbbuuuuffffffffeeeerrrr____ssssiiiizzzzeeee,,,, bbbbuuuuffffffffeeeerrrr)
  16.            _W_i_d_g_e_t       wwwwiiiiddddggggeeeetttt;
  17.            _X_m_T_e_x_t_P_o_s_i_t_i_o_nssssttttaaaarrrrtttt;
  18.            _i_n_t       nnnnuuuummmm____cccchhhhaaaarrrrssss;
  19.            _i_n_t       bbbbuuuuffffffffeeeerrrr____ssssiiiizzzzeeee;
  20.            _w_c_h_a_r__t       *bbbbuuuuffffffffeeeerrrr;
  21.  
  22.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  23.       _X_m_T_e_x_t_G_e_t_S_u_b_s_t_r_i_n_g_W_c_s    retrieves a copy of a portion of the
  24.       internal text    buffer of a Text widget    that is    stored in a
  25.       wide character format.  The function copies a    specified
  26.       number of characters from a given start position in the
  27.       internal text    buffer into a buffer provided by the
  28.       application.    A NULL terminator is placed at the end of the
  29.       copied data.
  30.  
  31.       wwwwiiiiddddggggeeeetttt
  32.            Specifies the Text widget ID.
  33.  
  34.       ssssttttaaaarrrrtttt
  35.            Specifies the beginning character position from which
  36.            the data    will be    retrieved.  This is an integer number
  37.            of characters from the beginning    of the text buffer.
  38.            The first character position is 0.
  39.  
  40.       nnnnuuuummmm____cccchhhhaaaarrrrssss
  41.            Specifies the number of _w_c_h_a_r__t characters to be    copied
  42.            into the    provided buffer.
  43.  
  44.       bbbbuuuuffffffffeeeerrrr____ssssiiiizzzzeeee
  45.            Specifies the size of the supplied buffer as a number
  46.            of _w_c_h_a_r__t storage locations.  The minimum size is
  47.            nnnnuuuummmm____cccchhhhaaaarrrrssss + 1.
  48.  
  49.       bbbbuuuuffffffffeeeerrrr
  50.            Specifies the wide character buffer into    which the
  51.            internal    text buffer will be copied.
  52.  
  53.       For a    complete definition of Text and    its associated
  54.       resources, see _X_m_T_e_x_t(_3_X).
  55.  
  56.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  57.       _X_m_C_O_P_Y__S_U_C_C_E_E_D_E_D
  58.            The function was    successful.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 11/11/03)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((3333XXXX))))
  71.  
  72.  
  73.  
  74.       _X_m_C_O_P_Y__F_A_I_L_E_D
  75.            The function failed because it was unable to copy the
  76.            specified number    of characters into the buffer
  77.            provided.  The buffer size may be insufficient.    The
  78.            contents    of bbbbuuuuffffffffeeeerrrr are undefined.
  79.  
  80.       _X_m_C_O_P_Y__T_R_U_N_C_A_T_E_D
  81.            The requested number of characters extended beyond the
  82.            internal    buffer.     The function copied characters
  83.            between ssssttttaaaarrrrtttt and the end of the    widget's buffer    and
  84.            terminated the string with a NULL terminator; fewer
  85.            than nnnnuuuummmm____cccchhhhaaaarrrrssss characters were copied.
  86.  
  87.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  88.       _X_m_T_e_x_t(_3_X) and _X_m_T_e_x_t_G_e_t_S_u_b_s_t_r_i_n_g(_3_X).
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                        (printed 11/11/03)
  130.  
  131.  
  132.  
  133.